api: change order of arguments in add_event #270
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
e4d8949 ("OpenTracing Bridge - Initial implementation (open-telemetry#211)") introduced a new timestamp argument to the add_event method. This commit moves that argument to be the last one because it is more common to have event attributes than an explicitly timestamp.
mauriciovasquezbernal
requested review from
a-feld,
c24t,
carlosalberto,
lzchen,
Oberon00,
reyang and
toumorokoshi
as code owners
Closed
c24t
reviewed
Nov 5, 2019
There was a problem hiding this comment.
The changes LGTM, but adding a few lines to test_span_members pushed it over the threshold for pylint to raise a too-many-statements.
We may want to disable this check eventually, but I think pylint is right in this case: this test would benefit from being broken up.
toumorokoshi
approved these changes
Nov 5, 2019
| @@ -75,7 +75,7 @@ def log_kv(self, key_values, timestamp=None): | |||
| event_timestamp = None | |||
|
|
|||
| event_name = util.event_name_from_kv(key_values) | |||
| self._otel_span.add_event(event_name, event_timestamp, key_values) | |||
| self._otel_span.add_event(event_name, key_values, event_timestamp) | |||
There was a problem hiding this comment.
I'd personally use explicit param names here, in order to be on the safe side (in case we change order in the future ;) )
There was a problem hiding this comment.
Actually having the parameters by position could be good because it can be a reminder that if the position is changed something could break.
carlosalberto
approved these changes
Nov 5, 2019
c24t
approved these changes
Nov 5, 2019
c24t
pushed a commit
that referenced
this pull request
Nov 23, 2019
The flask integration has (only) two advantages over the plain WSGI middleware approach: - It can use the endpoint as span name (which is lower cardinality than the route; cf #270) - It can set the http.route attribute. In addition, it also has an easier syntax to enable (you don't have to know about Flask.wsgi_app).
srikanthccv
pushed a commit
to srikanthccv/opentelemetry-python
that referenced
this pull request
Nov 1, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
e4d8949 ("OpenTracing Bridge - Initial implementation (#211)") introduced
a new timestamp argument to the add_event method. This commit moves that
argument to be the last one because it is more common to have event attributes
than an explicitly timestamp.